﻿<!DOCTYPE html>
<!--[if IE]><![endif]-->
<html>

  <head>
    <meta charset="utf-8">
    <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
    <title>Parameters </title>
    <meta name="viewport" content="width=device-width">
    <meta name="title" content="Parameters ">
    <meta name="generator" content="docfx ">
  
    <link rel="shortcut icon" href="../../../api/images/favicon.ico">
    <link rel="stylesheet" href="../../../styles/docfx.vendor.css">
    <link rel="stylesheet" href="../../../styles/docfx.css">
    <link rel="stylesheet" href="../../../styles/main.css">
    <link href="https://fonts.googleapis.com/css?family=Roboto" rel="stylesheet"> 
    <meta property="docfx:navrel" content="../../../toc.html">
    <meta property="docfx:tocrel" content="../../toc.html">
    <script type="text/javascript" async="" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.7/MathJax.js?config=TeX-MML-AM_CHTML"></script>
  
  
  
  </head>  <body data-spy="scroll" data-target="#affix" data-offset="120">
    <div id="wrapper">
      <header>

        <nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
          <div class="container">
            <div class="navbar-header">
              <button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
                <span class="sr-only">Toggle navigation</span>
                <span class="icon-bar"></span>
                <span class="icon-bar"></span>
                <span class="icon-bar"></span>
              </button>

              <a class="navbar-brand" href="../../../index.html">
                <img id="logo" class="svg" src="../../../api/images/favicon.svg" alt="">
              </a>
            </div>
            <div class="collapse navbar-collapse" id="navbar">
              <form class="navbar-form navbar-right" role="search" id="search">
                <div class="form-group">
                  <input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
                </div>
              </form>
            </div>
          </div>
        </nav>

        <div class="subnav navbar navbar-default">
          <div class="container hide-when-search" id="breadcrumb">
            <ul class="breadcrumb">
              <li></li>
            </ul>
          </div>
        </div>
      </header>
      <div role="main" class="container body-content hide-when-search">

        <div class="sidenav hide-when-search">
          <a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
          <div class="sidetoggle collapse" id="sidetoggle">
            <div id="sidetoc"></div>
          </div>
        </div>
        <div class="article row grid-right">
          <div class="col-md-10">
            <article class="content wrap" id="_content" data-uid="">
<h1 id="parameters">Parameters</h1>

<p>In many cases, electronic components are described by <em>parameters</em>. Parameters can be set on entities or electronic components, and are passed to the simulation behaviors when they are created.</p>
<h2 id="example---a-diode">Example - A diode</h2>
<p>A diode is described by the following conventions:</p>
<p align="center"><img src="images/example_circuit_mna_dio.svg" alt="Diode definition" width="100px"></p>
<p><span class="math">\(i_D = I_{SS}\left(e^\frac{v_A-v_B}{\eta V_T}\right)\)</span></p>
<p>In the equation that describes the diode, we can see that we have two parameters: <span class="math">\(I_{SS}\)</span> and <span class="math">\(\eta\)</span>. The factor <span class="math">\(V_T = \frac{k\cdot T}{q}\)</span> is in fact only determined by constants (the Boltzmann constant <span class="math">\(k\)</span>, electron charge <span class="math">\(q\)</span> and temperature <span class="math">\(T\)</span>).</p>
<pre><code class="lang-csharp" name="Circuit">using SpiceSharp.ParameterSets;

namespace SpiceSharpTest.DiodeBehaviors
{
    /// &lt;summary&gt;
    /// Parameters used for our diode model.
    /// &lt;/summary&gt;
    public class DiodeParameters : ParameterSet&lt;DiodeParameters&gt;
    {
        /// &lt;summary&gt;
        /// Gets or sets the ideality factor eta.
        /// &lt;/summary&gt;
        public double Eta { get; set; }

        /// &lt;summary&gt;
        /// Gets or sets the saturation current.
        /// &lt;/summary&gt;
        public double Iss { get; set; }
    }
}
</code></pre>
</article>
          </div>

          <div class="hidden-sm col-md-2" role="complementary">
            <div class="sideaffix">
              <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
                <h5>In this article</h5>
                <div></div>
              </nav>
            </div>
          </div>
        </div>
      </div>

      <footer>
        <div class="grad-bottom"></div>
        <div class="footer">
          <div class="container">
            <span class="pull-right">
              <a href="#top">Back to top</a>
            </span>
      
      <span>Generated by <strong>DocFX</strong></span>
          </div>
        </div>
      </footer>
    </div>

    <script type="text/javascript" src="../../../styles/docfx.vendor.min.js"></script>
    <script type="text/javascript" src="../../../styles/docfx.js"></script>
    <script type="text/javascript" src="../../../styles/main.js"></script>
  </body>
</html>
